/*
 * File:    Constants.java
 * Created: 28-Oct-2007
 * Version: $Id$
 * 
 * COPYRIGHT (C) 2007, 2008, Bitgate Software, LLC.  All Rights Reserved.
 * 
 * software@bitgatesoftware.com
 */

package com.bitgate.util.config;

/**
 * This class is a helper enumeration class that is used to help walk the configuration file loaded for a service.
 * 
 * @author kenji
 * @since 0.7.0
 */
public enum Constants {

	/** Services objects. */
	SERVICES_OBJECT("/services/object"),
	
	/** Database objects. */
	DATABASE_OBJECT("/database/object");
	
	private final String constantName;
	
	private Constants(String constantName) {
		this.constantName = constantName;
	}
	
	/**
	 * Retrieves the name of the specified object.
	 * 
	 * @return <code>String</code> containing the object XPath.
	 */
	public String get() {
		return constantName;
	}
	
	/**
	 * Retrieves the name of the specified object with an positional counter.
	 * 
	 * @param counter <code>int</code> containing the counter position.
	 * @return <code>String</code> containing the object XPath.
	 */
	public String get(int counter) {
		return constantName + "[" + counter + "]";
	}
	
}